Docs for the push activity tracking #984

Aviatorscode2 · 2025-10-15T00:10:30Z

Summary by CodeRabbit

Documentation
- Added “Push Notification Activity Tracking” guide describing the end-to-end workflow to capture push interactions, forward events from your backend, and view them in the Activity Feed.
- Included client examples for Expo, FCM, OneSignal and general push providers, plus server examples showing event forwarding.
- Updated docs navigation to surface the new page.

linear · 2025-10-15T00:10:33Z

MRK-1077 Build documentation for Push Inbound Webhooks using DX Guide

coderabbitai · 2025-10-15T00:11:10Z

Walkthrough

Adds a new documentation page "push-activity-tracking" describing a client→backend→Novu workflow for forwarding push interaction events, and updates the push integration metadata to include the new page in its pages array.

Changes

Cohort / File(s)	Summary of Changes
Push Docs Metadata `content/docs/platform/integrations/push/meta.json`	Added `"push-activity-tracking"` to the `pages` array.
Push Activity Tracking Doc `content/docs/platform/integrations/push/push-activity-tracking.mdx`	New documentation page describing enabling Push Activity Tracking, obtaining Environment/Integration IDs, client-side capture examples (Expo, FCM, OneSignal), backend forwarding via Novu API/SDK, and end-to-end flow to the Activity Feed.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant U as Client App
  participant B as App Backend
  participant N as Novu API
  participant F as Novu Activity Feed

  rect rgba(200,230,255,0.25)
    note over U: Step 2 — capture push interaction on device
    U->>B: POST /track-push {eventType,eventId,timestamp,content,deviceId,platform}
  end

  rect rgba(220,255,220,0.25)
    note over B: Step 3 — backend forwards to Novu
    B->>N: trackActivity({environmentId,integrationId,requestBody})
    N-->>B: HTTP 2xx/4xx
  end

  rect rgba(255,240,200,0.25)
    note over N,F: Step 4 — event appears in Activity Feed
    N-->>F: store/display event
  end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Focus review on:
- Accuracy and formatting of push-activity-tracking.mdx (code samples, IDs, steps).
- Correct inclusion and ordering of the new page in content/docs/platform/integrations/push/meta.json.

Suggested reviewers

djabarovgeorge
DianaHackmamba

Poem

I twitch my whiskers at the log,
A push hops in and skips a beat,
From pocket to burrow, an event on the jog,
I trace each hop with tiny feet.
Cheers — new tracks to nibble and greet! 🐰

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Docs for the push activity tracking' accurately and directly summarizes the main change: adding documentation for push activity tracking functionality, which aligns with the new documentation page and metadata updates.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch MRK-1077

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e51b6e8 and 3b87eac.

📒 Files selected for processing (1)

content/docs/platform/integrations/push/push-activity-tracking.mdx (1 hunks)

✅ Files skipped from review due to trivial changes (1)

content/docs/platform/integrations/push/push-activity-tracking.mdx

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Build and Lint

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

netlify · 2025-10-15T00:11:27Z

❌ Deploy Preview for docs-novu failed. Why did it fail? →

Name	Link
🔨 Latest commit	`2e45c6d`
🔍 Latest deploy log	https://app.netlify.com/projects/docs-novu/deploys/690b5b0c5be3050008be5267

coderabbitai

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e96aa5b and 453e1cb.

⛔ Files ignored due to path filters (1)

public/images/channels-and-providers/push/activity-tracking/enable-activity-tracking.png is excluded by !**/*.png

📒 Files selected for processing (2)

content/docs/platform/integrations/push/meta.json (1 hunks)
content/docs/platform/integrations/push/push-activity-tracking.mdx (1 hunks)

content/docs/platform/integrations/push/push-activity-tracking.mdx

….mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

content/docs/platform/integrations/push/push-activity-tracking.mdx

….mdx Co-authored-by: DianaHackmamba <[email protected]>

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (2)

content/docs/platform/integrations/push/push-activity-tracking.mdx (2)
7-9: Fix the incomplete sentence in the introduction.

Line 9 is a sentence fragment that disrupts the flow. It should be restructured to form a complete sentence or better connected to the previous thought.

Suggested fix:
- Where your application captures and forwards push notification events to the Novu. Once received, Novu processes and displays these events alongside other channels for a unified tracking experience.
+ This is where your application captures and forwards push notification events to Novu. Once received, Novu processes and displays these events alongside other channels for a unified tracking experience.
151-151: Break up the long concluding sentence for readability.

The final sentence is dense and could be split into two shorter sentences for better flow:
- Once these steps are completed, your application will send push notification engagement data to Novu, giving you a complete, unified view of your notification performance in the Activity Feed.
+ Once these steps are completed, your application will send push notification engagement data to Novu. This gives you a complete, unified view of your notification performance in the Activity Feed.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f6240c and 7cb8754.

📒 Files selected for processing (1)

content/docs/platform/integrations/push/push-activity-tracking.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Build and Lint

content/docs/platform/integrations/push/push-activity-tracking.mdx

….mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

content/docs/platform/integrations/push/push-activity-tracking.mdx

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Docs for the push activity tracking

453e1cb

Aviatorscode2 requested review from DianaHackmamba and djabarovgeorge October 15, 2025 00:10

coderabbitai bot reviewed Oct 15, 2025

View reviewed changes

Update content/docs/platform/integrations/push/push-activity-tracking…

4f6240c

….mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

DianaHackmamba requested changes Oct 15, 2025

View reviewed changes

Aviatorscode2 and others added 10 commits November 3, 2025 11:50

Update content/docs/platform/integrations/push/push-activity-tracking…

adce17b

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

81598ca

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

ae61565

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

269a6a9

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

9162e34

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

d6ffc80

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

64a7acf

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

827b037

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Break last sentente

1fc1dbb

Update content/docs/platform/integrations/push/push-activity-tracking…

7cb8754

….mdx Co-authored-by: DianaHackmamba <[email protected]>

coderabbitai bot reviewed Nov 3, 2025

View reviewed changes

content/docs/platform/integrations/push/push-activity-tracking.mdx Outdated Show resolved Hide resolved

content/docs/platform/integrations/push/push-activity-tracking.mdx Outdated Show resolved Hide resolved

Aviatorscode2 and others added 3 commits November 3, 2025 12:03

Update content/docs/platform/integrations/push/push-activity-tracking…

c446ba1

….mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Implement feedback for Push activity docs

73d229d

Merge branch 'MRK-1077' of https://github.com/novuhq/docs into MRK-1077

d5d6003

Aviatorscode2 requested a review from DianaHackmamba November 3, 2025 17:50

DianaHackmamba requested changes Nov 4, 2025

View reviewed changes

Aviatorscode2 and others added 5 commits November 5, 2025 15:11

Update content/docs/platform/integrations/push/push-activity-tracking…

2e45c6d

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

d2de1ee

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

adf64ca

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

d300f61

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content/docs/platform/integrations/push/push-activity-tracking…

e51b6e8

….mdx Co-authored-by: DianaHackmamba <[email protected]>

Update content based on feedback

3b87eac

Aviatorscode2 requested a review from DianaHackmamba November 5, 2025 14:25

DianaHackmamba approved these changes Nov 5, 2025

View reviewed changes

Aviatorscode2 merged commit 11e499b into main Nov 5, 2025
6 checks passed

Aviatorscode2 deleted the MRK-1077 branch November 5, 2025 22:28

Docs for the push activity tracking #984

Docs for the push activity tracking #984

Uh oh!

Conversation

Aviatorscode2 commented Oct 15, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

linear bot commented Oct 15, 2025

Uh oh!

coderabbitai bot commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

netlify bot commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Deploy Preview for docs-novu failed. Why did it fail? →

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Aviatorscode2 commented Oct 15, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 15, 2025 •

edited

Loading

netlify bot commented Oct 15, 2025 •

edited

Loading